<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>RestAPI: RestAPI.amazon.S3.S3session Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">RestAPI
   &#160;<span id="projectnumber">0.0.2</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>RestAPI</b>      </li>
      <li class="navelem"><b>amazon</b>      </li>
      <li class="navelem"><b>S3</b>      </li>
      <li class="navelem"><a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html">S3session</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">RestAPI.amazon.S3.S3session Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="RestAPI::amazon::S3::S3session" --><!-- doxytag: inherits="RestAPI::amazon::service::AWSservice" -->
<p>A <a class="el" href="namespaceS3.html" title="This is the module that wraps all Amazon S3 funtionality.">S3</a> session that can be used to interact with <a class="el" href="namespaceS3.html" title="This is the module that wraps all Amazon S3 funtionality.">S3</a> online services.  
 <a href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for RestAPI.amazon.S3.S3session:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classRestAPI_1_1amazon_1_1S3_1_1S3session.png" usemap="#RestAPI.amazon.S3.S3session_map" alt=""/>
  <map id="RestAPI.amazon.S3.S3session_map" name="RestAPI.amazon.S3.S3session_map">
<area href="classRestAPI_1_1amazon_1_1service_1_1AWSservice.html" title="The abstract class of Amazon Web Service." alt="RestAPI.amazon.service.AWSservice" shape="rect" coords="0,0,223,24"/>
</map>
 </div></div>

<p><a href="classRestAPI_1_1amazon_1_1S3_1_1S3session-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#a05dfd1eea485d0232e1bd79c9d04ae78">__init__</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a <a class="el" href="namespaceS3.html" title="This is the module that wraps all Amazon S3 funtionality.">S3</a> session in given location.  <a href="#a05dfd1eea485d0232e1bd79c9d04ae78"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a002246d038eaa0ac0019693758fa82a3"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::setCredential" ref="a002246d038eaa0ac0019693758fa82a3" args="" -->
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#a002246d038eaa0ac0019693758fa82a3">setCredential</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the credential information of the current bucket. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#af3ae82d52125510979a032ccca232da5">buckets</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">List the buckets owned by the owner of current <a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html" title="A S3 session that can be used to interact with S3 online services.">S3session</a>.  <a href="#af3ae82d52125510979a032ccca232da5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a940ad89e98573cf8af1f414fa47ef352"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::createBucket" ref="a940ad89e98573cf8af1f414fa47ef352" args="" -->
def&#160;</td><td class="memItemRight" valign="bottom"><b>createBucket</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#ad74250390bcb76917674c2d4e6240e40">deleteBucket</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the bucket of given name.  <a href="#ad74250390bcb76917674c2d4e6240e40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#a337a81039b860f12db9c81d472124f73">__getitem__</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get bucket by the given name.  <a href="#a337a81039b860f12db9c81d472124f73"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92052f6421633921715243d97cfa9b0b"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::createBucketObj" ref="a92052f6421633921715243d97cfa9b0b" args="" -->
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#a92052f6421633921715243d97cfa9b0b">createBucketObj</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initalize a bucket object in memory based on the given information. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f315411ab9dbc513a5c377b1ed285e0"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::setOwner" ref="a5f315411ab9dbc513a5c377b1ed285e0" args="" -->
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRestAPI_1_1amazon_1_1service_1_1AWSservice.html#a5f315411ab9dbc513a5c377b1ed285e0">setOwner</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the owner of the AWS service. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a126b6103f4723a3e0df4418129a38619"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::location" ref="a126b6103f4723a3e0df4418129a38619" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>location</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cb4eae52afe8f9173d926cb5566998b"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::host" ref="a5cb4eae52afe8f9173d926cb5566998b" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>host</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab96c46827fa039729ad4f970da6af26d"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::AuthKey" ref="ab96c46827fa039729ad4f970da6af26d" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>AuthKey</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a286112ac4ddf61e6a074816057e898a6"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::SecretAccessKey" ref="a286112ac4ddf61e6a074816057e898a6" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>SecretAccessKey</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80363e40614d35bb83b87996e4ff3f1b"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::securityToken" ref="a80363e40614d35bb83b87996e4ff3f1b" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>securityToken</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fdbcdd363669f3405857293dfc408d7"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::acl" ref="a1fdbcdd363669f3405857293dfc408d7" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>acl</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b90ac665df43f62855be48673d152f1"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::LOCATION" ref="a2b90ac665df43f62855be48673d152f1" args="" -->
tuple&#160;</td><td class="memItemRight" valign="bottom"><b>LOCATION</b> = (&quot;EU&quot; , &quot;eu-west-1&quot; , &quot;us-west-1&quot; , &quot;us-west-2&quot;, &quot;ap-southeast-1&quot; , &quot;ap-northeast-1&quot; , &quot;sa-east-1&quot; , &quot;&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af428dc476b50d125f0da0b20dde55591"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::ACL_OPTIONS" ref="af428dc476b50d125f0da0b20dde55591" args="" -->
tuple&#160;</td><td class="memItemRight" valign="bottom"><b>ACL_OPTIONS</b> = (&quot;private&quot; , &quot;public-read&quot; , &quot;public-read&quot; , &quot;authenticated-read&quot; , &quot;bucket-owner-read&quot; , &quot;bucket-owner-full-control&quot;)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="namespaceS3.html" title="This is the module that wraps all Amazon S3 funtionality.">S3</a> session that can be used to interact with <a class="el" href="namespaceS3.html" title="This is the module that wraps all Amazon S3 funtionality.">S3</a> online services. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a05dfd1eea485d0232e1bd79c9d04ae78"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::__init__" ref="a05dfd1eea485d0232e1bd79c9d04ae78" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#a05dfd1eea485d0232e1bd79c9d04ae78">RestAPI.amazon.S3.S3session.__init__</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>locale</em> = <code>'us'</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Start a <a class="el" href="namespaceS3.html" title="This is the module that wraps all Amazon S3 funtionality.">S3</a> session in given location. </p>
<p>Possible locations are: oregon,california,eu,singapore,sao paulo </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a337a81039b860f12db9c81d472124f73"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::__getitem__" ref="a337a81039b860f12db9c81d472124f73" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#a337a81039b860f12db9c81d472124f73">RestAPI.amazon.S3.S3session.__getitem__</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>bucketName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get bucket by the given name. </p>

</div>
</div>
<a class="anchor" id="af3ae82d52125510979a032ccca232da5"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::buckets" ref="af3ae82d52125510979a032ccca232da5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#af3ae82d52125510979a032ccca232da5">RestAPI.amazon.S3.S3session.buckets</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>List the buckets owned by the owner of current <a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html" title="A S3 session that can be used to interact with S3 online services.">S3session</a>. </p>
<p>Returns a list of <a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1Bucket.html" title="Data Holder for S3 bucket.">Bucket</a> objects. </p>

</div>
</div>
<a class="anchor" id="ad74250390bcb76917674c2d4e6240e40"></a><!-- doxytag: member="RestAPI::amazon::S3::S3session::deleteBucket" ref="ad74250390bcb76917674c2d4e6240e40" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classRestAPI_1_1amazon_1_1S3_1_1S3session.html#ad74250390bcb76917674c2d4e6240e40">RestAPI.amazon.S3.S3session.deleteBucket</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>bucketName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Delete the bucket of given name. </p>
<p>The content of the bucket must be removed at first. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>amazon/S3.py</li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 24 2013 00:42:20 for RestAPI by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
